实时模板变量

展开实时模板缩写时，其变量要么显示为输入字段，您可以在其中键入值，要么替换为值。这些可能是您可以修改的默认值或使用函数计算的值。

要在模板中声明变量，请使用以下格式：$VAR$.

在表达式中，使用变量名，不要打开和关闭美元字符$，例如，lowercaseAndDash(ComponentName).

要将美元字符添加$到模板文本中以使其不被视为变量声明，请使用特殊变量$$。

使用表达式定义每个变量，并为表达式无法评估的情况提供默认值。

此表达式可能包含以下结构：

双引号中的字符串常量

实时模板中定义的其他变量的名称

带有可能参数的预定义函数

在Settings/Preferences对话框 ( Ctrl+Alt+S) 中，转到Editor | 实时模板。

选择要在其中配置变量的模板。

在模板文本中指定变量，然后单击编辑变量。

在“编辑模板变量”对话框中，您可以对每个变量执行以下操作：

更改变量名称

使用预定义函数定义表达式

指定表达式无法计算时的默认值

如果表达式计算成功，则指定在提示用户输入时是否要跳过变量

WebStorm 支持以下无法修改的预定义实时模板变量：

$END$表示代码片段完成后光标所在的位置，不能再按Tab跳转到下一个变量。

$SELECTION$在环绕模板中使用，表示要包装的代码片段。模板展开后，它将按照模板中指定的方式包装选定的文本。例如，如果您EXAMPLE在代码中选择并"$SELECTION$"通过指定的缩写或通过Ctrl+Alt+T从列表中按下并选择所需的模板来调用模板，WebStorm 将用双引号将所选内容括起来，如下所示："EXAMPLE".

以下函数可用于定义实时模板变量：

功能

描述

blockCommentEnd()

返回指示当前语言上下文中块注释结束的字符。

blockCommentStart()

返回指示当前语言上下文中块注释开始的字符。

camelCase()

将字符串转换为camelCase。

例如，camelCase("my-text-file")，camelCase("my text file")，并且camelCase("my_text_file")全部返回myTextFile。

capitalize()

将字符串的第一个字母大写。

例如，capitalize("name")返回Name. 或者你可以将它组合capitalize(camelCase("my awesome class"))成MyAwesomeClass.

capitalizeAndUnderscore()

将字符串的所有字母大写，并在各部分之间插入下划线。

例如，capitalizeAndUnderscore("FooBar")，capitalizeAndUnderscore("foo bar")，并且capitalizeAndUnderscore("foo-bar")全部返回FOO_BAR。

clipboard()

返回系统剪贴板的内容。

commentEnd()

返回指示当前语言上下文中注释结束的字符。对于带有行注释的语言，返回值为空。

commentStart()

返回指示当前语言上下文中注释开始的字符。对于带有行注释的语言，返回值是行注释的开始，与lineCommentStart()相同。

complete()

在变量的位置调用代码完成。

concat(, ...)

返回作为参数传递给函数的所有字符串的串联。

例如，concat(date()," ",user())返回当前系统日期和用空格分隔的用户名。

dartIterableVariable()

返回可以迭代的变量的名称。

dartListVariable()

返回数组元素的列表。

dartSuggestIndexName()

从最常用的索引变量中返回建议的名称：i、j、k和子。当前范围内尚未使用的名称首先显示。

dartSuggestVariableName()

根据引用变量命名规则的代码样式设置，根据变量类型和初始化表达式返回建议的变量名称。例如，如果它是一个在迭代中保存元素的变量，WebStorm 会猜测最合理的名称，同时考虑到被迭代的容器的名称。

date([format])

返回当前系统日期。

默认情况下，不带参数，它以当前系统格式返回日期。要使用不同的格式，请根据SimpleDateFormat规范提供参数。例如，date("Y-MM-d, E, H:m")返回格式为 的日期2020-02-27, Thu, 16:11。

dbColumns()

返回表或视图的列列表。用于上下文实时模板（dbColumns()例如，ins）。您可以通过右键单击对象并选择SQL Scripts来访问上下文实时模板。

dbObjectName()

返回表或视图的名称。用于上下文实时模板（dbObjectName()例如，top）。您可以通过右键单击对象并选择SQL Scripts来访问上下文实时模板。

decapitalize()

用相应的小写字母替换字符串的第一个字母。

例如，decapitalize("Name")返回name.

defaultReturnValues

如果在 return 语句中使用表达式，则返回默认值。errorVariableName如果表达式属于错误类型，则使用参数。

enum(, ...)

返回模板展开时建议完成的字符串列表。

例如，enum("Foo","Bar","Baz")显示一个列表，您可以从中选择一个指定的字符串。

escapeString()

转义特殊字符，以便可以在 Java 字符串中使用结果。

例如，它将制表符替换为\t，换行符替换为\n，将反斜杠转义为\\，引号替换为\"，等等。

expectedType()

返回模板展开的表达式的预期类型（在赋值的右侧， after return，作为方法参数，等等）。

fileName()

返回当前文件的名称及其扩展名。

fileNameWithoutExtension()

返回当前文件的名称，不带扩展名。

filePath()

返回当前文件的绝对路径。

fileRelativePath()

返回相对于当前项目的当前文件路径。要检查给定文件的相对路径，请右键单击它并选择Copy Reference，或按Ctrl+Alt+Shift+C。

firstWord()

返回作为参数传递的字符串的第一个单词。

例如，firstWord("one two three")返回one.

groovyScript(, [arg, ...])

执行作为字符串传递的 Groovy 脚本。

第一个参数是一个字符串，其中包含脚本的文本或包含脚本的文件的路径。该函数将其他可选参数作为_1、_2、_3、 ..._n变量的值传递给脚本。此外，您可以使用该_editor变量从脚本内部访问当前编辑器。

以下示例显示了一个groovyScript()函数，该函数将所选文本拆分为单词并将它们显示为编号列表：

JsArrayVariable()

返回当前 JavaScript 数组的名称。

jsClassName()

返回当前 JavaScript 类的名称。

jsComponentTypeOf()

返回当前 JavaScript 组件的类型。

jsDefineParameter

根据模块名称，返回参数 from define(["module"], function (>) {})。

jsMethodName()

返回当前 JavaScript 方法的名称。

jsQualifiedClassName()

返回当前 JavaScript 类的完整名称。

jsSuggestDefaultVariableKind(Boolean)

Boolean 参数确定在当前上下文中是否允许使用常量。如果未指定参数，则允许使用常量。当模板展开时，会显示一个列表，其中var包含TypeScript 和 ES6 的选项，而早期 JavaScript 版本只有一个let选项。constvar

jsSuggestImportedEntityName()

`import * as $ITEM$ from "$MODULE$"`建议类型或`import $ITEM$ from "$MODULE$"`基于文件名的导入语句的名称。

jsSuggestIndexName()

从最常用的索引变量中返回建议的名称：i、j、k和子。当前范围内尚未使用的名称首先显示。

jsSuggestVariableName()

根据引用变量命名规则的代码样式设置，根据变量类型和初始化表达式返回建议的变量名称。例如，如果它是一个在迭代中保存元素的变量，WebStorm 会猜测最合理的名称，同时考虑到被迭代的容器的名称。

lineCommentStart()

返回指示当前语言上下文中行注释开始的字符。

lineNumber()

返回当前行号。

lowercaseAndDash()

将字符串转换为小写并插入 n 破折号作为分隔符。例如，lowercaseAndDash("MyExampleName")两者lowercaseAndDash("my example name")都返回my-example-name.

regularExpression(, , )

查找 a 中所有出现的Pattern并String用 替换它们Replacement。您可以将模式指定为正则表达式以在字符串中查找与其匹配的所有内容。

snakeCase()

将字符串转换为snake_case。例如，snakeCase("fooBar")两者snakeCase("foo bar")都返回foo_bar.

spaceSeparated()

返回以空格作为分隔符的指定字符串。例如，spaceSeparated("fooBar")退货foo Bar和spaceSeparated("Foo_BAR")退货Foo BAR。

spacesToUnderscores()

将作为参数传递的字符串中的空格替换为下划线。例如，spacesToUnderscores("foo bar BAZ")返回foo_bar_BAZ.

substringBefore(, )

返回子字符串直到指定的分隔符。这有助于删除测试文件名中的扩展名。例如，如果在名为component-test.jssubstringBefore(fileName(),".")的文件中使用，则返回。component-test

time([format])

返回当前系统时间。

默认情况下，不带参数，以当前系统格式返回时间。要使用不同的格式，请根据SimpleDateFormat规范提供参数。例如，time("H:m z")返回格式为 的时间13:10 UTC。

underscoresToCamelCase()

将带下划线的字符串（如snake_case）转换为camelCase。例如，underscoresToCamelCase(foo_bar_baz)两者underscoresToCamelCase(FOO_BaR_baZ)都返回fooBarBaz.

underscoresToSpaces()

将字符串中的下划线转换为空格。例如，underscoresToSpaces(foo_bar_baz)退货foo bar baz和underscoresToSpaces(FOO_BaR_baZ)退货FOO BaR baZ。

user()

返回当前用户的名称。

让我们为 Angular 组件创建一个ngcomp模板，类似于默认的a-component. 模板将有 3 个变量：

第一个，$ComponentName$，将成为新组件类名称的占位符。

第二个，$selector$，将成为组件选择器的名称。

第三个， ，表示在模板展开并填写$END$$ComponentName$ 和占位符后光标应该在末尾的位置。$selector$

在编辑器中，选择要在模板中使用的代码，按Ctrl+Shift+A，然后调用Save as Live Template...操作。

输入您将用于调用模板的缩写，例如ngcomp，并添加模板描述，例如New Angular 组件。

将变量添加到模板中。

替换SearchComponent为$ComponentName$。

selector: $selector$,里面加Component({})。

添加$END$到ngOnInit(){}.

根据Angular Style Guide，选择器名称通常是组件名称的破折号版本，因此首先指定组件名称是有意义的。但是，选择器首先出现在代码中。

要解决此问题，请单击编辑变量并使用箭头图标调整变量的顺序。现在ComponentName先出现，插入符号将在模板扩展时首先跳转到它。

如果我们可以只指定类名并通过类名转换自动填写选择器名，那就太好了。为此，请单击变量旁边的表达式字段，从列表中选择函数，然后键入作为其参数。selectorlowercaseAndDashComponentName

与模板主体不同，在“编辑模板变量”对话框中，使用变量的名称时无需打开和关闭美元字符$。

可选：

如果在旁边定义，您可以选择跳过selector。在这种情况下，编辑元件名称并按Enter后，光标将转到该$END$位置而不是$selector$。

让我们看看我们的新模板的实际效果：